Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation generation support to the reference integration workspace using Bazel and Sphinx. The changes enable building comprehensive documentation from multiple integrated S-CORE modules via the bazel run //:docs_combo_experimental command.
- Enables documentation building through Bazel by adding the
score_docs_as_codeandscore_processdependencies - Configures Sphinx documentation with module collection support for
score_platformandscore_process - Sets up a GitHub Actions workflow for automated documentation builds and deployments
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| score_modules.MODULE.bazel | Adds score_docs_as_code (v2.0.1) and score_process (v1.3.1) dependencies; switches score_persistency to version override; switches score_platform to git override for fixes |
| docs/requirements.txt | Removes placeholder file (no longer needed) |
| docs/index.rst | Creates main documentation page with reference to platform and process module documentation |
| docs/conf.py | Adds Sphinx configuration with project metadata and required extensions |
| README.md | Documents the new docs generation command |
| BUILD | Uncomments and configures the docs() rule with data dependencies |
| .gitignore | Adds documentation build artifacts to ignore list |
| .github/workflows/docs.yml | Adds GitHub Actions workflow for building and deploying documentation |
| .bazelrc | Adds Java 17 configuration required for Bazel build |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kgraeper
approved these changes
Nov 11, 2025
a-zw
reviewed
Nov 11, 2025
| "@score_platform//:needs_json", | ||
| "@score_process//:needs_json", | ||
| # Persistency cannot be included, as it does not contain any needs. | ||
| # -> sphinx-needs bug? |
antonkri
approved these changes
Nov 11, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
First version which supports
bazel run //:docs_combo_experimental